get_last_error_text
This function retrieves the textual error description set by the last engine function or object method that you called.
string get_last_error_text()
Parameters:
None.
Return value:
An error description if an error occured in the last call, or a blank string otherwise.
Remarks:
Many engine functions and object methods cannot give any specific information about an error that it encountered via its return value, such as the input_box function which returns an empty string if an error occurs. This, however, can also happen if the user just clicks OK which makes it impossible to distinguish these two conditions from one another. This is when the get_last_error_text function comes in handy. It will return a textual error description that the engine function or object method specified before returning, which allows you to determine with much greater exactitude what went wrong.
The get_last_error_text function will return a blank string if no error occured in the last call. This means that the error is reset for every new call to an engine function or object method, so you should retrieve the error description before making any other calls.
The error description returned by the get_last_error_text function is not affected by calls to any of your own functions or methods.
Example:
// Attempt to open a file that we can be fairly sure does not exist, and print the output from get_last_error_text.
void main()
{
file reader;
reader.open("a_file_that_is_dead");
alert("Result", get_last_error_text());
}